home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_xemacs.idb / usr / freeware / lib / xemacs-20.4 / lisp / hm--html-menus / README.z / README
Encoding:
Text File  |  1998-05-21  |  10.7 KB  |  287 lines
  1. This README file describes the emacs lisp package hm--html-menus-5.8.
  2.  
  3. The package provides functions and various popup and pulldown menus
  4. for a html mode called hm--html-mode, a mode for writing html pages.
  5. It provides also a minor mode (hm--html-minor-mode), which can be used
  6. together with another html major mode, like the psgml-html mode in the
  7. XEmacs 19.15.
  8.  
  9. It has an interface to view the html documents in a W3 browser with
  10. Netscape, the w3-package from William M. Perry and Mosaic with the
  11. file html-view.el from Ron Tapia.  It provides also a drag and drop
  12. interface, which makes it very easy to insert links or images, by just
  13. clicking on them.
  14.  
  15. Look at the file NEWS, to see what is new in this release. Some 
  16. of the major changes are also listed in the ANNOUNCEMENT file.
  17.  
  18. You should (but don't need) also get the w3 package from:
  19.  
  20.  cs.indiana.edu:/pub/elisp/w3/w3.tar.z
  21.  
  22. which provides an world wide web browser mode for the xemacs, emacs
  23. and epoch.
  24.  
  25.  
  26. This package is tested with the xemacs 19.15 on Suns with SunOS 5.5
  27. and on PC's with linux. But it should work also on other (possibly
  28. only UNIX ?) platforms.
  29.  
  30. Read the file README-EMACS-19, if you want to use this package with
  31. GNU Emacs 19. 
  32.  
  33. Thanks to Richard Stallman, who helped me to port this package to the
  34. Emacs 19, thanks to John Ladwig, who corrected a lot of the text and
  35. comments in this package and thanks to Michael D. Harnois, who
  36. corrected the Texinfo documentation and to all the other people like
  37. Jerry G. DeLapp, Andreas Ernst, Bob Weiner, Luca Pisati, Guylaine
  38. Prat, Gary D. Foster, Martin Buchholz, Ola Stromfors, Berthold
  39. Crysmann, Noriaki Seki, Valeriy E. Ushakov, D-P Deng, Rick
  40. Braumoeller, Sean Dowd and so on, who provided code, ideas, bug fixes
  41. or bug reports for this package.
  42.  
  43.  
  44. The package consists of the following files:
  45.  
  46. README                : this file;
  47. README-EMACS-19            : only for the GNU Emacs 19 user;
  48. ANNOUNCEMENT            : Text of the announcement of this package;
  49. LSM                : Entry for the Linux Software Map;
  50. NEWS                : Change logfile;
  51. adapt.el            : provides functions to use this package 
  52.                   with the GNU Emacs 19
  53. hm--html.el            : provides functions to write html pages;
  54.                   in this file are all commands defined,
  55.                   which inserts html elements and entities;
  56. hm--html-indentation.el        : provides the indentation stuff;
  57. hm--html-keys.el        : provides the keybindings;
  58. hm--html-menu.el        : provides the menus;
  59. hm--html-mode.el        : provides the functions for the definition
  60.                   of the hm--html-mode; this is now the
  61.                   main file of the package;
  62. hm--html-not-standard.el    : provides functions to insert some
  63.                   non standard html elements;
  64.                   this file is not evaluated by default;
  65. hm--html-configuration.el    : configuration file for the html mode;
  66.                   choose this as system configuration file;
  67. hm--html-drag-and-drop.el    : defines the HTML- specific functions
  68.                   for the drag and drop interface;
  69. hm--date.el            : defines the function hm--date, which 
  70.                   returns the date in the format 
  71.                   "day-month-year" like "30-Jun-1993".
  72. html-view.el            : Ron Tapia's html-view.el to view html-pages
  73.                   in the Xmosaic; it is patched for the use
  74.                   with the xemacs;
  75. internal-drag-and-drop.el    : provides the general (html-mode 
  76.                   independend functions) of the drag and
  77.                   drop interface;
  78. templates.doc            : describes the syntax of the templates 
  79.                   provided in the file tmpl-minor-mode.el
  80. tmpl-minor-mode.el        : provides functions for the tmpl-minor-mode;
  81.                   with this mode you can expand templates,
  82.                   which are described in the file
  83.                   templates-syntax.doc (look at the files
  84.                   command-description.html.tmpl and
  85.                   frame.html.tmpl for examples);
  86.                   templates can be expanded automatically, if
  87.                   you include a file with templates via the
  88.                   html pulldown menu item "Templates ..."
  89.                   or with the item "Templates (fixed dirs)...";
  90. command-description.html.tmpl    : Templatefile for the use with the
  91.                   tmpl-minor-mode;
  92. frame.html.tmpl            : Templatefile, provides a simple frame;
  93. drop                : xbm file with the drag and drop mouse pointer
  94. dropmsk                : xbm file with mask for the d&d mouse pointer
  95. doc/hm--html-mode.texinfo    : Package documentation in the Texinfo format;
  96. doc/umlaute.texinfo        : Texinfo include file for german vowel 
  97.                   mutation (deutsche Umlaute);
  98.  
  99.  
  100.  
  101.  
  102. INSTALLATION:
  103. =============
  104.  
  105. Note: In this version the setting of the environment variables 
  106. HTML_CONFIG_FILE and HTML_USER_CONFIG_FILE are no longer necessary,
  107. if you put the user configuration file in the home directory and
  108. the system configuration file in one of the load path directories
  109. of your XEmacs or Emacs 19.
  110.  
  111. 1.     Put all the *.el files in one of your xemacs (or emacs) lisp load
  112.         directories (i.e. lisp/packages).
  113.  
  114. 2.    For XEmacs only: Put the files drop and dropmask in the
  115.     directory specified by the lisp variable `idd-data-directory'.
  116.     By default this directory is <prefix>/lib/xemacs-<version>/etc/idd.
  117.     (eg: if you've installed the Xemacs 19.15 in /usr/local, it is
  118.     /usr/local/xemacs/lib/xemacs-19.15/etc/idd).
  119.     If you'd like to put the files in another directory, then you must
  120.     set the variable `idd-data-directory' to this directory (eg: 
  121.     (setq idd-data-directory "/usr/local/data")
  122.  
  123. 3.    Put the following in your .emacs (or default.el or site-init.el):
  124.  
  125.     (autoload 'hm--html-mode "hm--html-mode" "HTML major mode." t)
  126.     (autoload 'hm--html-minor-mode "hm--html-mode" "HTML minor mode." t)
  127.     (or (assoc "\\.html$" auto-mode-alist)
  128.             (setq auto-mode-alist (cons '("\\.html$" . hm--html-mode) 
  129.                         auto-mode-alist)))
  130.  
  131.     (autoload 'tmpl-expand-templates-in-buffer "tmpl-minor-mode"
  132.       "Expand all templates in the current buffer." t)
  133.  
  134.         (autoload 'html-view-start-mosaic "html-view" "Start Xmosaic." t)
  135.         (autoload 'html-view-view-buffer 
  136.       "html-view"
  137.       "View the current buffer in Xmosaic."
  138.       t)
  139.         (autoload 'html-view-view-file 
  140.       "html-view"
  141.       "View a file in Xmosaic."
  142.       t)
  143.         (autoload 'html-view-goto-url
  144.       "html-view"
  145.       "Goto url in Xmosaic."
  146.       t)
  147.         (autoload 'html-view-get-display
  148.       "html-view"
  149.       "Get the display for Xmosaic (i.e. hostxy:0.0)."
  150.       t)
  151.         (autoload 'w3-preview-this-buffer "w3" "WWW Previewer" t)
  152.     (autoload 'w3 "w3" "WWW Browser" t)
  153.     (autoload 'w3-open-local "w3" "Open local file for WWW browsing" t)
  154.     (autoload 'w3-fetch "w3" "Open remote file for WWW browsing" t)
  155.     (autoload 'w3-use-hotlist "w3" "Use shortcuts to view WWW docs" t)
  156.  
  157.     The above lines assume that you have not installed already another
  158.     html mode. If this isn't true, then you should use the following
  159.  
  160.     (setq auto-mode-alist (cons '("\\.html$" . hm--html-mode) 
  161.                         auto-mode-alist))
  162.  
  163.     instead of
  164.  
  165.     (or (assoc "\\.html$" auto-mode-alist)
  166.             (setq auto-mode-alist (cons '("\\.html$" . hm--html-mode) 
  167.                         auto-mode-alist)))
  168.  
  169.     It could also be, that you've already the autoload lines for
  170.         the w3 package in your emacs.
  171.  
  172.     If you want to use this the hm--html-minor-mode together
  173.     with the psgml-html modes, then you should add the following
  174.     line (works only in XEmacs version >= 19.15 and != 20.0)
  175.     (add-hook 'html-mode-hook 'hm--html-minor-mode)
  176.  
  177. 4.    Set (if you want) the environment variable HTML_CONFIG_FILE 
  178.     to the html system configuration file i.e.:    
  179.     setenv HTML_CONFIG_FILE /usr/xemacs/lisp/hm--html-configuration.el
  180.  
  181. 5.    Set (if you want) the environment variable HTML_USER_CONFIG_FILE to 
  182.     the html user configuration file i.e.:
  183.     setenv HTML_USER_CONFIG_FILE ~/.hm--html-configuration.el
  184.     And put the file .hm--html-configuration.el in your Home directory.
  185.     An example for this user specific file is given below.
  186.  
  187. 6.    Check the files hm--html-configuration.el and 
  188.     .hm--html-configuration.el whether all variables are set suitable for 
  189.     you and your site or not. You can make changes in both of these files
  190.     and you can also create a site specific configuration file, called
  191.     hm--html-site-config-file.el and specified by the lisp variable
  192.     hm--html-site-config-file or the environment variable
  193.         HTML_SITE_CONFIG_FILE, and put your site specific settings in this
  194.     file. A site specific configuration file is useful, if you're a
  195.     system administrator and want to make site specific settings
  196.     without changing a file of this package or use the normal emacs
  197.         configuration files.
  198.     Note that .hm--html-configuration.el precedes the settings in
  199.     hm--html-site-config-file.el, which precedes the settings in
  200.     hm--html-configuration.el (user specific configuration overwrites
  201.     site specific configuration and site specific configuration 
  202.     overwrites the settings made by the package).
  203.  
  204.     Look at first at the following variables:
  205.  
  206.         hm--html-signaturefile
  207.         hm--html-username
  208.         hm--html-template-dir
  209.         hm--html-favorite-http-server-host-name
  210.         html-document-previewer
  211.         html-view-mosaic-command
  212.         w3-default-homepage
  213.  
  214. 7.    If you want to use templatefiles, you should put these files
  215.     in the directory to which `hm--html-template-dir' points.
  216.     You can use the file command-description.html.tmpl as
  217.     an example.
  218.  
  219. 8.    If you don't want to use the feature of adding html comments
  220.     about the creation date and author and with a change log, then
  221.     you should set the following three variables to nil:
  222.           hm--html-automatic-changed-comment
  223.          hm--html-automatic-created-comment
  224.  
  225. 9.      If you don't want to set a date in the title line, than you should
  226.         set the following to nil:
  227.          hm--html-automatic-new-date
  228.  
  229. The following is an example for a user specific configuration file
  230. called .hm--html-configuration.el. You should put such a file in your
  231. home directory and put all the variable settings in it, which are user
  232. specific. 
  233.  
  234. ---- BEGIN of .hm--html-configuration.el ----
  235. ;;; Private html configuration file
  236.  
  237. ;; Signature file
  238. (setq hm--html-signature-file 
  239.       "http://www.tnt.uni-hannover.de:80/data/info/www/tnt/org/tnt/whois/wissmit/muenkel.html")
  240.  
  241. ;; Username (Only necessary if it differs from the passwd entry)
  242. (setq hm--html-username "Heiko Mⁿnkel")
  243.  
  244.  
  245. ;; X Window System display for the html-view
  246. (setq html-view-display "daedalus:0.0")
  247.  
  248.  
  249. ;; Use the expert menus?
  250. (setq hm--html-expert t)
  251.  
  252.  
  253. ;; Delete the automounter path prefix /tmp_mount
  254. (setq hm--html-delete-wrong-path-prefix "/tmp_mount")
  255.  
  256.  
  257. ;;;
  258. ;
  259. ; W3 
  260.  
  261. ;; Default Home Page for w3-mode in lemacs or GNU Emacs
  262. (setq w3-default-homepage "file:/home/muenkel/data/docs/www/home.html")
  263. ---- END of .hm--html-configuration.el ----
  264.  
  265.  
  266. Every hm--*.el file has a description and installation part. Look at first
  267. at these parts, if you have any questions.
  268.  
  269. Look at first at the configuration files, if you have problems with
  270. this package!
  271.  
  272. You should also look at the Texinfo documentation of this package.
  273.  
  274. There is a html documentation about the package. You can find it on:
  275. http://www.tnt.uni-hannover.de/~muenkel/software/own/hm--html-menus/overview.html
  276.  
  277.  
  278. Please send any bug reports, fixes or comments to 
  279.         muenkel@daedalus.tnt.uni-hannover.de
  280.  
  281.  
  282. I hope these files will be useful,
  283.  
  284. Heiko
  285.  
  286.  
  287.